home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 February / EnigmA AMIGA RUN 15 (1997)(G.R. Edizioni)(IT)[!][issue 1997-02][PLANET CD V].iso / enigma / earcd / business / autorexx.lha / Rexx / MicroDox.txt next >
Text File  |  1996-12-28  |  10KB  |  129 lines
  1.  
  2. ---:GREETZ:------------------------------------------------------------
  3.  
  4. Greetings! Below is a micro-summary of the files in the AutoRexx plugIn range.
  5.  
  6. All AutoRexx PlugIns are copyrighted by the Author stated in each entry.
  7.  
  8. You are welcome to modify the code to suit your own setup, but if you use it
  9. to build another plug-in, please send me a copy with microdox at a minimum
  10. please, and I'll include it in the archive with your permission.
  11.  
  12.      If you would prefer I not distribute it, please state so CLEARLY,
  13.      otherwise permission WILL BE ASSUMED.
  14.  
  15.  
  16. ---:BLURB:-------------------------------------------------------------
  17.  
  18. I started using DB and found it to be a bitch to get the hang of.  Internal
  19. editing was bitchy-hard without any real GUI builder (see note.1) and the
  20. output file was confusing to say the least.  Since there seems to be no real
  21. structure to the RFF, it's flexible, but annoying.  So, with a peek through
  22. the samples, and what dox there are, and some good pointers from a friend who
  23. introduced me to DB, I started building the AutoRexx range of DB PlugIns.
  24.  
  25. Note.1:  I love DB, don't get me wrong, it's just no where near finished, and
  26. thus is still a mess to use internally, and confusing manually. There is, as
  27. yet, no really effective internal designer, so we still have to play manually.
  28.  
  29.      Anyways, if you like, please use. A note to say 'Howdee' would be nice,
  30. but not required.If you alter, please don't remove any of my copyright notes.
  31. Fair's fair, y'know. If you use as a basis for new AutoRexx plugIns, please
  32. send me a copy, as requested above.
  33.  
  34.      Karl Mottram - karl@bifrost.manawatu.gen.nz - 19961228 23:30:00
  35.  
  36. Now, on to the MicroDox...
  37.  
  38.  
  39. ---:MICRODOX FORMAT:---------------------------------------------------
  40.  
  41. - <filename> - <quickdescription>
  42.      Auth: Code author - code is copyrighted by this person.
  43.  
  44.      Args: Args to pass it on invocation. C= standard /<codes> please.
  45.      Func: Quick function summary.
  46.      Incl: Sample entry, with syntax. NAME= -> NEXT= please.
  47.      Note: Any notes the author wants pointed out.
  48.  
  49.      Head:
  50. <sample DB database, excluding entries, to demo applied code in action.>
  51.  
  52.  
  53. ---:MICRODOX:-------------------------------------------------
  54.  
  55. - XportSumm.rexx - Collects, collates and writes summary data.
  56.      Auth: Karl Mottram
  57.  
  58.      Args: None
  59.      Func: To automate a summary system for fiscal accounting.
  60.      Incl: NAME=Su_mmarised,FTYP=checkbox,OFFS=10,SIZE=2,AUTORXFILE="DB:Rexx/XportSumm.rexx",NEXT=nl
  61.      Note: Output file may not be suitable, feel free to modify/junk this.
  62.  
  63.      Head:
  64. JNum    Client    Date    Amount    QTY    File    Desc    Paid    PDate    Costs    Summ    Trigger
  65. @RFF=1.1,TYPE=internal,CMNT="AutoRexx PlugIns © 1996 Karl Mottram - Teknofile Services",RXPORTNAME=TFJOB                            FLEN=800                    
  66. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=QuickScan    NAME="Job #",OFFS=0,SIZE=5,NEXT=tab    NAME=Paid,OFFS=7,SIZE=2,NEXT=space    NAME=Summ,OFFS=10,SIZE=2,NEXT=nl    NAME=Client,OFFS=1,SIZE=27,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=3,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=nl
  67. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=FullScan    NAME="Job _#",OFFS=0,SIZE=7,AUTORXFILE=DB:PlugIns/AIClient.rexx,NEXT=tab    NAME="Job _Date",OFFS=2,SIZE=10,NEXT=tab    NAME=_Paid,FTYP=checkbox,OFFS=7,SIZE=2,AUTORXFILE="DB:PlugIns/AddDate.rexx Paid PDate",NEXT=space    NAME=on,FTYP=text,OFFS=8,SIZE=9,NEXT=nl    NAME=_Client,OFFS=1,SIZE=30,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=8,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=space    NAME=Su_mmarised,FTYP=checkbox,OFFS=10,SIZE=2,AUTORXFILE="DB:Rexx/XportSumm.rexx",NEXT=nl    NAME=_File(s,OFFS=5,SIZE=57,NEXT=para    NAME="_Amount $",OFFS=3,SIZE=23,NEXT=space    NAME="Costs _$",OFFS=9,SIZE=23,NEXT=para    NAME=_Qty,OFFS=4,SIZE=8,NEXT=nl    NAME=Desc,FTYP=textfield,ROWS=5,OFFS=6,SIZE=57,NEXT=nl
  68.  
  69.  
  70. - AddDate.rexx - DB PlugIn : Auto-Insert current date into DB field.
  71.      Auth: Karl Mottram
  72.  
  73.      Args: TagField/S OutField/S
  74.      Func: Auto-insert current date into target DB database.
  75.      Incl: NAME=_Paid,FTYP=checkbox,OFFS=7,SIZE=2,AUTORXFILE="DB:PlugIns/AddDate.rexx Paid PDate",NEXT=nl
  76.      Note: Could be launched from Trigger.rexx if you removed TagField code.
  77.  
  78.      Head:
  79. JNum    Client    Date    Amount    QTY    File    Desc    Paid    PDate    Costs    Summ    Trigger
  80. @RFF=1.1,TYPE=internal,CMNT="AutoRexx PlugIns © 1996 Karl Mottram - Teknofile Services",RXPORTNAME=TFJOB                            FLEN=800                    
  81. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=QuickScan    NAME="Job #",OFFS=0,SIZE=5,NEXT=tab    NAME=Paid,OFFS=7,SIZE=2,NEXT=space    NAME=Summ,OFFS=10,SIZE=2,NEXT=nl    NAME=Client,OFFS=1,SIZE=27,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=3,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=nl
  82. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=FullScan    NAME="Job _#",OFFS=0,SIZE=7,AUTORXFILE=DB:PlugIns/AIClient.rexx,NEXT=tab    NAME="Job _Date",OFFS=2,SIZE=10,NEXT=tab    NAME=_Paid,FTYP=checkbox,OFFS=7,SIZE=2,AUTORXFILE="DB:PlugIns/AddDate.rexx Paid PDate",NEXT=space    NAME=on,FTYP=text,OFFS=8,SIZE=9,NEXT=nl    NAME=_Client,OFFS=1,SIZE=30,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=8,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=space    NAME=Su_mmarised,FTYP=checkbox,OFFS=10,SIZE=2,AUTORXFILE="DB:Rexx/XportSumm.rexx",NEXT=nl    NAME=_File(s,OFFS=5,SIZE=57,NEXT=para    NAME="_Amount $",OFFS=3,SIZE=23,NEXT=space    NAME="Costs _$",OFFS=9,SIZE=23,NEXT=para    NAME=_Qty,OFFS=4,SIZE=8,NEXT=nl    NAME=Desc,FTYP=textfield,ROWS=5,OFFS=6,SIZE=57,NEXT=nl
  83.  
  84.  
  85. - AIClient.rexx - DB PlugIn : Auto-Insert Client name into database
  86.      Auth: Karl Mottram
  87.  
  88.      Args: None
  89.      Func: Checks in list, and inserts applicable label
  90.      Incl: NAME="Job _#",OFFS=0,SIZE=7,AUTORXFILE=DB:PlugIns/AIClient.rexx,NEXT=nl
  91.      Note: Edit script file paths for custom usage.
  92.  
  93.      Head:
  94. JNum    Client    Date    Amount    QTY    File    Desc    Paid    PDate    Costs    Summ    Trigger
  95. @RFF=1.1,TYPE=internal,CMNT="AutoRexx PlugIns © 1996 Karl Mottram - Teknofile Services",RXPORTNAME=TFJOB                            FLEN=800                    
  96. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=QuickScan    NAME="Job #",OFFS=0,SIZE=5,NEXT=tab    NAME=Paid,OFFS=7,SIZE=2,NEXT=space    NAME=Summ,OFFS=10,SIZE=2,NEXT=nl    NAME=Client,OFFS=1,SIZE=27,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=3,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=nl
  97. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=FullScan    NAME="Job _#",OFFS=0,SIZE=7,AUTORXFILE=DB:PlugIns/AIClient.rexx,NEXT=tab    NAME="Job _Date",OFFS=2,SIZE=10,NEXT=tab    NAME=_Paid,FTYP=checkbox,OFFS=7,SIZE=2,AUTORXFILE="DB:PlugIns/AddDate.rexx Paid PDate",NEXT=space    NAME=on,FTYP=text,OFFS=8,SIZE=9,NEXT=nl    NAME=_Client,OFFS=1,SIZE=30,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=8,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=space    NAME=Su_mmarised,FTYP=checkbox,OFFS=10,SIZE=2,AUTORXFILE="DB:Rexx/XportSumm.rexx",NEXT=nl    NAME=_File(s,OFFS=5,SIZE=57,NEXT=para    NAME="_Amount $",OFFS=3,SIZE=23,NEXT=space    NAME="Costs _$",OFFS=9,SIZE=23,NEXT=para    NAME=_Qty,OFFS=4,SIZE=8,NEXT=nl    NAME=Desc,FTYP=textfield,ROWS=5,OFFS=6,SIZE=57,NEXT=nl
  98.  
  99.  
  100. - GetClient.rexx - DB PlugIn : Sets DB to start of Client entries
  101.      Auth: Karl Mottram
  102.  
  103.      Args: CDat/S Flag/S
  104.      Func: Searches database for search-string, and sets CURRENTRECORD to entry
  105.      Incl: Best set to run from within Trigger environment.
  106.      Note: See code for acceptable FLAG args and functions derived.
  107.  
  108.      Head:
  109. JNum    Client    Date    Amount    QTY    File    Desc    Paid    PDate    Costs    Summ    Trigger
  110. @RFF=1.1,TYPE=internal,CMNT="AutoRexx PlugIns © 1996 Karl Mottram - Teknofile Services",RXPORTNAME=TFJOB                            FLEN=800                    
  111. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=QuickScan    NAME="Job #",OFFS=0,SIZE=5,NEXT=tab    NAME=Paid,OFFS=7,SIZE=2,NEXT=space    NAME=Summ,OFFS=10,SIZE=2,NEXT=nl    NAME=Client,OFFS=1,SIZE=27,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=3,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=nl
  112. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=FullScan    NAME="Job _#",OFFS=0,SIZE=7,AUTORXFILE=DB:PlugIns/AIClient.rexx,NEXT=tab    NAME="Job _Date",OFFS=2,SIZE=10,NEXT=tab    NAME=_Paid,FTYP=checkbox,OFFS=7,SIZE=2,AUTORXFILE="DB:PlugIns/AddDate.rexx Paid PDate",NEXT=space    NAME=on,FTYP=text,OFFS=8,SIZE=9,NEXT=nl    NAME=_Client,OFFS=1,SIZE=30,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=8,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=space    NAME=Su_mmarised,FTYP=checkbox,OFFS=10,SIZE=2,AUTORXFILE="DB:Rexx/XportSumm.rexx",NEXT=nl    NAME=_File(s,OFFS=5,SIZE=57,NEXT=para    NAME="_Amount $",OFFS=3,SIZE=23,NEXT=space    NAME="Costs _$",OFFS=9,SIZE=23,NEXT=para    NAME=_Qty,OFFS=4,SIZE=8,NEXT=nl    NAME=Desc,FTYP=textfield,ROWS=5,OFFS=6,SIZE=57,NEXT=nl
  113.  
  114.  
  115. - Trigger.rexx - DB PlugIn : A simple trigger to tag checkboxes
  116.      Auth: Karl Mottram
  117.  
  118.      Args: PlugIn/S
  119.      Func: Simple dumb-trigger which resets itself.
  120.      Incl: NAME="",FTYP=checkbox,OFFS=11,SIZE=8,AUTORXFILE="DB:PlugIns/Trigger.rexx <PlugIn>",NEXT=nl
  121.      Note: Handy for tagging checkboxes mainly.
  122.  
  123.      Head:
  124. JNum    Client    Date    Amount    QTY    File    Desc    Paid    PDate    Costs    Summ    Trigger
  125. @RFF=1.1,TYPE=internal,CMNT="AutoRexx PlugIns © 1996 Karl Mottram - Teknofile Services",RXPORTNAME=TFJOB                            FLEN=800                    
  126. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=QuickScan    NAME="Job #",OFFS=0,SIZE=5,NEXT=tab    NAME=Paid,OFFS=7,SIZE=2,NEXT=space    NAME=Summ,OFFS=10,SIZE=2,NEXT=nl    NAME=Client,OFFS=1,SIZE=27,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=3,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=nl
  127. @RFF=1.1,TYPE=form,TABSIZE=10,LNAM=FullScan    NAME="Job _#",OFFS=0,SIZE=7,AUTORXFILE=DB:PlugIns/AIClient.rexx,NEXT=tab    NAME="Job _Date",OFFS=2,SIZE=10,NEXT=tab    NAME=_Paid,FTYP=checkbox,OFFS=7,SIZE=2,AUTORXFILE="DB:PlugIns/AddDate.rexx Paid PDate",NEXT=space    NAME=on,FTYP=text,OFFS=8,SIZE=9,NEXT=nl    NAME=_Client,OFFS=1,SIZE=30,NEXT=space    NAME="",FTYP=checkbox,OFFS=11,SIZE=8,AUTORXFILE="DB:PlugIns/Trigger.rexx GetClient.rexx x -p",NEXT=space    NAME=Su_mmarised,FTYP=checkbox,OFFS=10,SIZE=2,AUTORXFILE="DB:Rexx/XportSumm.rexx",NEXT=nl    NAME=_File(s,OFFS=5,SIZE=57,NEXT=para    NAME="_Amount $",OFFS=3,SIZE=23,NEXT=space    NAME="Costs _$",OFFS=9,SIZE=23,NEXT=para    NAME=_Qty,OFFS=4,SIZE=8,NEXT=nl    NAME=Desc,FTYP=textfield,ROWS=5,OFFS=6,SIZE=57,NEXT=nl
  128.  
  129.